Skip to content

issue_2501_addition_of_missing_safety_docs_templates#574

Merged
pahmann merged 43 commits intoeclipse-score:mainfrom
attifunel:attifunel_missing_safety_docs_templates
Mar 4, 2026
Merged

issue_2501_addition_of_missing_safety_docs_templates#574
pahmann merged 43 commits intoeclipse-score:mainfrom
attifunel:attifunel_missing_safety_docs_templates

Conversation

@attifunel
Copy link
Contributor

As per #2501, missing safety specific documentation templates were added

@github-actions
Copy link

The created documentation from the pull request is available at: docu-html

@attifunel attifunel changed the title Addition of missing safety docs templates issue_2501_Addition_of_missing_safety_docs_templates Feb 18, 2026
@attifunel attifunel changed the title issue_2501_Addition_of_missing_safety_docs_templates issue_2501_addition_of_missing_safety_docs_templates Feb 18, 2026
@pahmann pahmann force-pushed the attifunel_missing_safety_docs_templates branch from 26e74d8 to 7a74e1b Compare February 18, 2026 16:00
Copy link
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general,align with #542, Structure for Folder and Headings, e.g. Platform should be used

Copy link
Contributor

@aschemmel-tech aschemmel-tech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comments and:

@attifunel
Copy link
Contributor Author

See inline comments and:

Should I deleted the template in guidance then?

@masc2023
Copy link
Contributor

@attifunel , you have still merge conflicts, please resolve them first

@attifunel
Copy link
Contributor Author

attifunel commented Feb 24, 2026

@attifunel , you have still merge conflicts, please resolve them first

I'm having issues in displaying them... they refer to a deleted file

Copy link
Contributor

@aschemmel-tech aschemmel-tech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see inline comments

Copy link
Contributor

@aschemmel-tech aschemmel-tech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inline comments plus: stakeholder requirements document template still missing?

@attifunel
Copy link
Contributor Author

Inline comments plus: stakeholder requirements document template still missing?

There's a host of templates already here https://eclipse-score.github.io/process_description/main/process_areas/requirements_engineering/guidance/requirements_templates.html
Not sure 1. should I "move" (i.e. create a ref.) only stakeholder one 2. if yes, where?

@aschemmel-tech
Copy link
Contributor

As discussed: only add the stakeholder requirement templates and replace the definition in the process area section by links for Platform/Feature/Component requirements.

Copy link
Contributor

@aschemmel-tech aschemmel-tech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previous comments fixed now - new comments inline

@pahmann pahmann force-pushed the attifunel_missing_safety_docs_templates branch from f9fd6c5 to 236d4fe Compare March 3, 2026 20:02
Signed-off-by: Philipp Ahmann <philipp.ahmann@de.bosch.com>
@pahmann pahmann force-pushed the attifunel_missing_safety_docs_templates branch from 236d4fe to e6bdf05 Compare March 3, 2026 20:05
Signed-off-by: Philipp Ahmann <philipp.ahmann@de.bosch.com>
Copy link
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beside the default attribute settings for security, fine for now

:id: doc__platform_release_note
:status: draft
:safety: ASIL_B
:security: NO
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, why did you remove Security: YES and let safety to ASIL_B? Please set both so user must actively set NO or QM, if needed. Not everything is safety: ASIL_B by default.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other templates it is always Safety ASIL B, security NO. In general this is just an example, I added a specific request below to set the required values

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway I think I fixed

masc2023
masc2023 previously approved these changes Mar 4, 2026
@masc2023
Copy link
Contributor

masc2023 commented Mar 4, 2026

@attifunel , still doc building errors

/home/runner/work/process_description/process_description/process/folder_templates/modules/module_name/docs/security_mgt/module_security_package_fdr.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/runner/work/process_description/process_description/process/folder_templates/modules/module_name/docs/security_mgt/module_security_plan.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/runner/work/process_description/process_description/process/folder_templates/modules/module_name/docs/security_mgt/module_security_plan_fdr.rst: WARNING: document isn't included in any toctree [toc.not_included]

@attifunel
Copy link
Contributor Author

attifunel commented Mar 4, 2026 via email

Signed-off-by: Philipp Ahmann <philipp.ahmann@de.bosch.com>
Copy link
Contributor

@aschemmel-tech aschemmel-tech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see my remarks covered

@pahmann pahmann merged commit dc031be into eclipse-score:main Mar 4, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants